home *** CD-ROM | disk | FTP | other *** search
/ The Fatted Calf / The Fatted Calf.iso / Demos / ByCompany / TipTop_Software / TipTop / Supplement / man / tcl / expr.n < prev    next >
Text File  |  1994-05-08  |  15KB  |  484 lines
  1. '\"
  2. '\" Copyright (c) 1993 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/tcl/man/RCS/expr.n,v 1.5 93/09/02 16:41:26 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .\" The definitions below are for supplemental macros used in Tcl/Tk
  24. .\" manual entries.
  25. .\"
  26. .\" .HS name section [date [version]]
  27. .\"    Replacement for .TH in other man pages.  See below for valid
  28. .\"    section names.
  29. .\"
  30. .\" .AP type name in/out [indent]
  31. .\"    Start paragraph describing an argument to a library procedure.
  32. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  33. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  34. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  35. .\"    needed;  use .AS below instead)
  36. .\"
  37. .\" .AS [type [name]]
  38. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  39. .\"    name are examples of largest possible arguments that will be passed
  40. .\"    to .AP later.  If args are omitted, default tab stops are used.
  41. .\"
  42. .\" .BS
  43. .\"    Start box enclosure.  From here until next .BE, everything will be
  44. .\"    enclosed in one large box.
  45. .\"
  46. .\" .BE
  47. .\"    End of box enclosure.
  48. .\"
  49. .\" .VS
  50. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  51. .\"    of man pages.
  52. .\"
  53. .\" .VE
  54. .\"    End of vertical sidebar.
  55. .\"
  56. .\" .DS
  57. .\"    Begin an indented unfilled display.
  58. .\"
  59. .\" .DE
  60. .\"    End of indented unfilled display.
  61. .\"
  62. '\"    # Heading for Tcl/Tk man pages
  63. .de HS
  64. .ds ^3 \\0
  65. .if !"\\$3"" .ds ^3 \\$3
  66. .if '\\$2'cmds'       .TH \\$1 1 \\*(^3 \\$4
  67. .if '\\$2'lib'        .TH \\$1 3 \\*(^3 \\$4
  68. .if '\\$2'tcl'        .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
  69. .if '\\$2'tk'         .TH \\$1 n \\*(^3 Tk "Tk Commands"
  70. .if '\\$2'tclc'        .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
  71. .if '\\$2'tkc'         .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
  72. .if '\\$2'tclcmds'         .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
  73. .if '\\$2'tkcmds'         .TH \\$1 1 \\*(^3 Tk "Tk Applications"
  74. .if t .wh -1.3i ^B
  75. .nr ^l \\n(.l
  76. .ad b
  77. ..
  78. '\"    # Start an argument description
  79. .de AP
  80. .ie !"\\$4"" .TP \\$4
  81. .el \{\
  82. .   ie !"\\$2"" .TP \\n()Cu
  83. .   el          .TP 15
  84. .\}
  85. .ie !"\\$3"" \{\
  86. .ta \\n()Au \\n()Bu
  87. \&\\$1    \\fI\\$2\\fP    (\\$3)
  88. .\".b
  89. .\}
  90. .el \{\
  91. .br
  92. .ie !"\\$2"" \{\
  93. \&\\$1    \\fI\\$2\\fP
  94. .\}
  95. .el \{\
  96. \&\\fI\\$1\\fP
  97. .\}
  98. .\}
  99. ..
  100. '\"    # define tabbing values for .AP
  101. .de AS
  102. .nr )A 10n
  103. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  104. .nr )B \\n()Au+15n
  105. .\"
  106. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  107. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  108. ..
  109. '\"    # BS - start boxed text
  110. '\"    # ^y = starting y location
  111. '\"    # ^b = 1
  112. .de BS
  113. .br
  114. .mk ^y
  115. .nr ^b 1u
  116. .if n .nf
  117. .if n .ti 0
  118. .if n \l'\\n(.lu\(ul'
  119. .if n .fi
  120. ..
  121. '\"    # BE - end boxed text (draw box now)
  122. .de BE
  123. .nf
  124. .ti 0
  125. .mk ^t
  126. .ie n \l'\\n(^lu\(ul'
  127. .el \{\
  128. .\"    Draw four-sided box normally, but don't draw top of
  129. .\"    box if the box started on an earlier page.
  130. .ie !\\n(^b-1 \{\
  131. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  132. .\}
  133. .el \}\
  134. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  135. .\}
  136. .\}
  137. .fi
  138. .br
  139. .nr ^b 0
  140. ..
  141. '\"    # VS - start vertical sidebar
  142. '\"    # ^Y = starting y location
  143. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  144. .de VS
  145. .mk ^Y
  146. .ie n 'mc \s12\(br\s0
  147. .el .nr ^v 1u
  148. ..
  149. '\"    # VE - end of vertical sidebar
  150. .de VE
  151. .ie n 'mc
  152. .el \{\
  153. .ev 2
  154. .nf
  155. .ti 0
  156. .mk ^t
  157. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  158. .sp -1
  159. .fi
  160. .ev
  161. .\}
  162. .nr ^v 0
  163. ..
  164. '\"    # Special macro to handle page bottom:  finish off current
  165. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  166. '\"    # page bottom macro.
  167. .de ^B
  168. .ev 2
  169. 'ti 0
  170. 'nf
  171. .mk ^t
  172. .if \\n(^b \{\
  173. .\"    Draw three-sided box if this is the box's first page,
  174. .\"    draw two sides but no top otherwise.
  175. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  176. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  177. .\}
  178. .if \\n(^v \{\
  179. .nr ^x \\n(^tu+1v-\\n(^Yu
  180. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  181. .\}
  182. .bp
  183. 'fi
  184. .ev
  185. .if \\n(^b \{\
  186. .mk ^y
  187. .nr ^b 2
  188. .\}
  189. .if \\n(^v \{\
  190. .mk ^Y
  191. .\}
  192. ..
  193. '\"    # DS - begin display
  194. .de DS
  195. .RS
  196. .nf
  197. .sp
  198. ..
  199. '\"    # DE - end display
  200. .de DE
  201. .fi
  202. .RE
  203. .sp .5
  204. ..
  205. .HS expr tcl 7.0
  206. .BS
  207. '\" Note:  do not modify the .SH NAME line immediately below!
  208. .SH NAME
  209. expr \- Evalue an expression
  210. .SH SYNOPSIS
  211. \fBexpr \fIarg \fR?\fIarg arg ...\fR?
  212. .BE
  213.  
  214. .SH DESCRIPTION
  215. .PP
  216. .VS
  217. Concatenates \fIarg\fR's (adding separator spaces between them),
  218. evaluates the result as a Tcl expression, and returns the value.
  219. .VE
  220. The operators permitted in Tcl expressions are a subset of
  221. the operators permitted in C expressions, and they have the
  222. same meaning and precedence as the corresponding C operators.
  223. Expressions almost always yield numeric results
  224. (integer or floating-point values).
  225. For example, the expression
  226. .DS
  227. \fBexpr 8.2 + 6\fR
  228. .DE
  229. evaluates to 14.2.
  230. Tcl expressions differ from C expressions in the way that
  231. operands are specified.  Also, Tcl expressions support
  232. non-numeric operands and string comparisons.
  233. .SH OPERANDS
  234. .PP
  235. A Tcl expression consists of a combination of operands, operators,
  236. and parentheses.
  237. White space may be used between the operands and operators and
  238. parentheses; it is ignored by the expression processor.
  239. Where possible, operands are interpreted as integer values.
  240. Integer values may be specified in decimal (the normal case), in octal (if the
  241. first character of the operand is \fB0\fR), or in hexadecimal (if the first
  242. two characters of the operand are \fB0x\fR).
  243. If an operand does not have one of the integer formats given
  244. above, then it is treated as a floating-point number if that is
  245. possible.  Floating-point numbers may be specified in any of the
  246. ways accepted by an ANSI-compliant C compiler (except that the
  247. ``f'', ``F'', ``l'', and ``L'' suffixes will not be permitted in
  248. most installations).  For example, all of the
  249. following are valid floating-point numbers:  2.1, 3., 6e4, 7.91e+16.
  250. If no numeric interpretation is possible, then an operand is left
  251. as a string (and only a limited set of operators may be applied to
  252. it).
  253. .PP
  254. Operands may be specified in any of the following ways:
  255. .IP [1]
  256. As an numeric value, either integer or floating-point.
  257. .IP [2]
  258. As a Tcl variable, using standard \fB$\fR notation.
  259. The variable's value will be used as the operand.
  260. .IP [3]
  261. As a string enclosed in double-quotes.
  262. The expression parser will perform backslash, variable, and
  263. command substitutions on the information between the quotes,
  264. and use the resulting value as the operand
  265. .IP [4]
  266. As a string enclosed in braces.
  267. The characters between the open brace and matching close brace
  268. will be used as the operand without any substitutions.
  269. .IP [5]
  270. As a Tcl command enclosed in brackets.
  271. The command will be executed and its result will be used as
  272. the operand.
  273. .IP [6]
  274. .VS
  275. As a mathematical function whose arguments have any of the above
  276. forms for operands, such as ``\fBsin($x)\fR''.  See below for a list of defined
  277. functions.
  278. .VE
  279. .LP
  280. Where substitutions occur above (e.g. inside quoted strings), they
  281. are performed by the expression processor.
  282. However, an additional layer of substitution may already have
  283. been performed by the command parser before the expression
  284. processor was called.
  285. As discussed below, it is usually best to enclose expressions
  286. in braces to prevent the command parser from performing substitutions
  287. on the contents.
  288. .PP
  289. For some examples of simple expressions, suppose the variable
  290. \fBa\fR has the value 3 and
  291. the variable \fBb\fR has the value 6.
  292. Then the command on the left side of each of the lines below
  293. will produce the value on the right side of the line:
  294. .DS
  295. .ta 6c
  296. \fBexpr 3.1 + $a    6.1
  297. expr 2 + "$a.$b"    5.6
  298. expr 4*[llength "6 2"]    8
  299. expr {{word one} < "word $a"}    0\fR
  300. .DE
  301. .SH OPERATORS
  302. .PP
  303. The valid operators are listed below, grouped in decreasing order
  304. of precedence:
  305. .TP 20
  306. \fB\-\0\0~\0\0!\fR
  307. Unary minus, bit-wise NOT, logical NOT.  None of these operands
  308. may be applied to string operands, and bit-wise NOT may be
  309. applied only to integers.
  310. .TP 20
  311. \fB*\0\0/\0\0%\fR
  312. Multiply, divide, remainder.  None of these operands may be
  313. applied to string operands, and remainder may be applied only
  314. to integers.
  315. .VS
  316. The remainder will always have the same sign as the divisor and
  317. an absolute value smaller than the divisor.
  318. .VE
  319. .TP 20
  320. \fB+\0\0\-\fR
  321. Add and subtract.  Valid for any numeric operands.
  322. .TP 20
  323. \fB<<\0\0>>\fR
  324. Left and right shift.  Valid for integer operands only.
  325. .TP 20
  326. \fB<\0\0>\0\0<=\0\0>=\fR
  327. Boolean less, greater, less than or equal, and greater than or equal.
  328. Each operator produces 1 if the condition is true, 0 otherwise.
  329. These operators may be applied to strings as well as numeric operands,
  330. in which case string comparison is used.
  331. .TP 20
  332. \fB==\0\0!=\fR
  333. Boolean equal and not equal.  Each operator produces a zero/one result.
  334. Valid for all operand types.
  335. .TP 20
  336. \fB&\fR
  337. Bit-wise AND.  Valid for integer operands only.
  338. .TP 20
  339. \fB^\fR
  340. Bit-wise exclusive OR.  Valid for integer operands only.
  341. .TP 20
  342. \fB|\fR
  343. Bit-wise OR.  Valid for integer operands only.
  344. .TP 20
  345. \fB&&\fR
  346. Logical AND.  Produces a 1 result if both operands are non-zero, 0 otherwise.
  347. Valid for numeric operands only (integers or floating-point).
  348. .TP 20
  349. \fB||\fR
  350. Logical OR.  Produces a 0 result if both operands are zero, 1 otherwise.
  351. Valid for numeric operands only (integers or floating-point).
  352. .TP 20
  353. \fIx\fB?\fIy\fB:\fIz\fR
  354. If-then-else, as in C.  If \fIx\fR
  355. evaluates to non-zero, then the result is the value of \fIy\fR.
  356. Otherwise the result is the value of \fIz\fR.
  357. The \fIx\fR operand must have a numeric value.
  358. .LP
  359. See the C manual for more details on the results
  360. produced by each operator.
  361. All of the binary operators group left-to-right within the same
  362. precedence level.  For example, the command
  363. .DS
  364. \fBexpr 4*2 < 7\fR
  365. .DE
  366. returns 0.
  367. .PP
  368. The \fB&&\fP, \fB||\fP, and \fB?:\fP operators have ``lazy
  369. evaluation'', just as in C, 
  370. which means that operands are not evaluated if they are
  371. not needed to determine the outcome.  For example, in the command
  372. .DS
  373. \fBexpr {$v ? [a] : [b]}\fR
  374. .DE
  375. only one of \fB[a]\fR or \fB[b]\fR will actually be evaluated,
  376. depending on the value of \fB$v\fP.  Note, however, that this is
  377. only true if the entire expression is enclosed in braces;  otherwise
  378. the Tcl parser will evaluate both \fB[a]\fR and \fB[b]\fR before
  379. invoking the \fBexpr\fR command.
  380. .SH "MATH FUNCTIONS"
  381. .PP
  382. .VS
  383. Tcl supports the following mathematical functions in expressions:
  384. .DS
  385. .ta 3c 6c 9c
  386. \fBacos\fR    \fBcos\fR    \fBhypot\fR    \fBsinh\fR
  387. \fBasin\fR    \fBcosh\fR    \fBlog\fR    \fBsqrt\fR
  388. \fBatan\fR    \fBexp\fR    \fBlog10\fR    \fBtan\fR
  389. \fBatan2\fR    \fBfloor\fR    \fBpow\fR    \fBtanh\fR
  390. \fBceil\fR    \fBfmod\fR    \fBsin\fR
  391. .DE
  392. Each of these functions invokes the math library function of the same
  393. name;  see the manual entries for the library functions for details
  394. on what they do.  Tcl also implements the following functions for
  395. conversion between integers and floating-point numbers:
  396. .TP
  397. \fBabs(\fIarg\fB)\fI
  398. Returns the absolute value of \fIarg\fR.  \fIArg\fR may be either
  399. integer or floating-point, and the result is returned in the same form.
  400. .TP
  401. \fBdouble(\fIarg\fB)\fR
  402. If \fIarg\fR is a floating value, returns \fIarg\fR, otherwise converts
  403. \fIarg\fR to floating and returns the converted value.
  404. .TP
  405. \fBint(\fIarg\fB)\fR
  406. If \fIarg\fR is an integer value, returns \fIarg\fR, otherwise converts
  407. \fIarg\fR to integer by truncation and returns the converted value.
  408. .TP
  409. \fBround(\fIarg\fB)\fR
  410. If \fIarg\fR is an integer value, returns \fIarg\fR, otherwise converts
  411. \fIarg\fR to integer by rounding and returns the converted value.
  412. .PP
  413. In addition to these predifined functions, applications may
  414. define additional functions using \fBTcl_CreateMathFunc\fR().
  415. .VE
  416. .SH "TYPES, OVERFLOW, AND PRECISION"
  417. .PP
  418. All internal computations involving integers are done with the C type
  419. \fIlong\fP, and all internal computations involving floating-point are
  420. done with the C type \fIdouble\fP.
  421. When converting a string to floating-point, exponent overflow is
  422. detected and results in a Tcl error.
  423. For conversion to integer from string, detection of overflow depends
  424. on the behavior of some routines in the local C library, so it should
  425. be regarded as unreliable.
  426. In any case, integer overflow and underflow are generally not detected
  427. reliably for intermediate results.  Floating-point overflow and underflow
  428. are detected to the degree supported by the hardware, which is generally
  429. pretty reliable.
  430. .PP
  431. Conversion among internal representations for integer, floating-point,
  432. and string operands is done automatically as needed.
  433. For arithmetic computations, integers are used until some
  434. floating-point number is introduced, after which floating-point is used.
  435. For example,
  436. .DS
  437. \fBexpr 5 / 4\fR
  438. .DE
  439. returns 1, while
  440. .DS
  441. \fBexpr 5 / 4.0\fR
  442. \fBexpr 5 / ( [string length "abcd"] + 0.0 )
  443. .DE
  444. both return 1.25.
  445. .VS
  446. Floating-point values are always returned with a ``.''
  447. or an ``e'' so that they will not look like integer values.  For
  448. example,
  449. .DS
  450. \fBexpr 20.0/5.0\fR
  451. .DE
  452. returns ``4.0'', not ``4''.  The global variable \fBtcl_precision\fR
  453. determines the the number of significant digits that are retained
  454. when floating values are converted to strings (except that trailing
  455. zeroes are omitted).  If \fBtcl_precision\fR
  456. is unset then 6 digits of precision are used.
  457. To retain all of the significant bits of an IEEE floating-point
  458. number set \fBtcl_precision\fR to 17;  if a value is converted to
  459. string with 17 digits of precision and then converted back to binary
  460. for some later calculation, the resulting binary value is guaranteed
  461. to be identical to the original one.
  462. .VE
  463.  
  464. .SH "STRING OPERATIONS"
  465. .PP
  466. String values may be used as operands of the comparison operators,
  467. although the expression evaluator tries to do comparisons as integer
  468. or floating-point when it can.
  469. If one of the operands of a comparison is a string and the other
  470. has a numeric value, the numeric operand is converted back to
  471. a string using the C \fIsprintf\fP format specifier
  472. \fB%d\fR for integers and \fB%g\fR for floating-point values.
  473. For example, the commands
  474. .DS
  475. \fBexpr {"0x03" > "2"}\fR
  476. \fBexpr {"0y" < "0x12"}\fR
  477. .DE
  478. both return 1.  The first comparison is done using integer
  479. comparison, and the second is done using string comparison after
  480. the second operand is converted to the string ``18''.
  481.  
  482. .SH KEYWORDS
  483. arithmetic, boolean, compare, expression
  484.